Micron Document
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| SparkN0de-git | SparkN0de |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Node / AutumnSpark1226 / AmberPages.git / commits / abad23a


Commit abad23a794ac815c208a94d054e3ee16fa7e1b60

󰉖 Browse tree at this commit

Parents : 46ed722
Author : AutumnSpark1226 <autumnspark1226@tuta.io>
Signature : Signature validation error
Date : 2025-06-15T13:15:50+02:00

add some documentation to README.md

Changes

1 files changed, 23 insertions(+), 0 deletions(-)

M README.md +23

Diff

diff --git a/README.md b/README.md
index cda654f..1f7d449 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
# AmberPages
+a list of NomadNet nodes
+
+### Setup
+`daemon.py` needs to run in the background. You can use the `amberpages.service` file to use it with systemd. Make sure to set `User=...`, `Group=...` and `ExecStart=...` correctly.
+By default the database will be stored in `~/.AmberPages/storage/pages.db`
+`AP.mu` must be in a folder which is served by NomadNet (usually somewhere in the `~/.nomadnetwork/storage/pages` directory).
+
+### Modify the page
+`AP.mu` has several configuration options. These are at the top of the file.
+- `node_name` - change "Hosted by NODE_NAME" in the default header
+- `sort` - change the sorting mode for entries; possible options are: `title`, `title_reverse`, `old`, `new`
+- `allow_usersort` - allows users to select a sorting mode
+- `lite_last_n_seconds` - only announces received within the last n seconds will be shown (this can save a lot of bandwidth)
+- `lite_limit_by_number_n` - only n entries will be shown (this can save a lot of bandwidth)
+- `list_link_colour` - set the coulour used for links in the list
+- `default_link_colour` - set the coulour used everywhere else
+- `show_last_updated` - show the time the page was generated
+- `last_update_timezone` - show time in this timezone
+- `header` - set a custom header, all micron is supported here
+
+### Repositories
+This software was created by [faragher](https://github.com/faragher) in [this repo](https://github.com/faragher/AmberPages) which is now archived.
+The current main repo is [on Codeberg](https://codeberg.org/AutumnSpark1226/AmberPages) as well as [on GitHub](https://github.com/AutumnSpark1226/AmberPages)
\ No newline at end of file


──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────